<!--
  ~ Copyright (C) 2010 Brockmann Consult GmbH (info@brockmann-consult.de)
  ~
  ~ This program is free software; you can redistribute it and/or modify it
  ~ under the terms of the GNU General Public License as published by the Free
  ~ Software Foundation; either version 3 of the License, or (at your option)
  ~ any later version.
  ~ This program is distributed in the hope that it will be useful, but WITHOUT
  ~ ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  ~ FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  ~ more details.
  ~
  ~ You should have received a copy of the GNU General Public License along
  ~ with this program; if not, see http://www.gnu.org/licenses/
  -->

<html>
<head>
    <title>Sentinel Toolbox Help - Histogram</title>
    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
    <link rel="stylesheet" href="../style.css">
</head>

<body>
<table class="header">
    <tr class="header">
        <td class="header">&nbsp;
            Histogram
        </td>

        <td class="header" align="right"><a href="../general/overview/SnapOverview.html"><img src="../images/snap_header.jpg"
                                                                                     border=0></a></td>
    </tr>
</table>


<h3>Histogram Display</h3>

<p>
    This dialog displays a histogram for the selected band. See the screenshot for an example.
</p>

<center>
    <img src="images/HistogramDialog.png">
</center>

<p>
    The value range of the geophysical image data is evenly divided into bins. The histogram shows how many pixels of
    the image fall into each of the bins.
</p>

<h4>Options Panel</h4>

<p>
    In the panel to the right there are several configuration options. Note that the histogram needs to be recomputed
    in order for configuration changes to take effect.
</p>

<ul>

    <li><b>Refresh View <img src="images/icons/ViewRefresh22.png"></b><br>
        Causes the histogram to be (re-)computed.
        The button is only enabled when a computation is expected to lead to a different histogram than the one on
        display.
    </li>

    <li><b>Collapse/Expand Options Panel <img src="images/icons/PanelRight12.png" border="1"> / <img
            src="images/icons/PanelLeft12.png" border="1"></b><br>
        Collapses or expands the options panel.
    </li>

    <li><b>ROI Mask</b><br>
        A ROI mask may be used to mask out values. All values which do not match the mask are not taken
        into account. For convenience, the mask manager may be openened from the histogram window using the
        <img src="images/icons/MaskManager24.png">-button.<br>
        For creating a ROI mask from the histogram, see 'Select Mask 'histogram_plot_area' from the context menu.
    </li>

    <li><b>Bins</b><br>
        The number of bins can be explicitly set.
        The bins will be evenly distributed in the defined value range.
    </li>

    <li><b>Log10 scaled bins</b><br>
        When this option is enabled, not the band values themselves but their common logarithms will be considered
        during the computation.
        Also the bin sizes will be log10 scaled.
        In the resulting plot, the x-axis will show the log10 scaled band values.
        You can use this option to turn a logarithmic into a normal distribution.
        <br/>
        This option will be disabled when the band contains no positive values.
    </li>

    <li><b>Auto min/max</b><br>
        When enabled, the minimum and maximum band value to be considered during the computation of the histogram are
        determined automatically.<br/>
        When disabled, the user may set these values.
    </li>

    <li><b>Log10 scaled</b><br>
        Causes the x-axis of the current histogram to be log10 scaled. This option will be disabled when the band
        contains at least one negative value or when the displayed histogram was created with log10 scaled values.
    </li>

    <li><b>Zoom all <img src="images/icons/View-Fullscreen22.png"></b><br>
        Adjusts both axes to the full data range.
        The 'Auto range' entry in the context menu can also be used (see below).
    </li>

    <li><b>Edit Properties <img src="images/icons/Edit24.gif"></b><br>
        Edit several properties (colors, axes, etc.) of the diagram.
        he 'Properties...' entry in the context menu can also be used (see below).
    </li>

    <li><b>Save chart as image <img src="images/icons/Export24.gif"></b><br>
        Save the diagram as image (PNG).
        The 'Save as...' entry in the context menu can also be used (see below).
    </li>

    <li><b>Print chart <img src="images/icons/Print24.gif"></b><br>
        Print the diagram.
        The 'Print...' entry in the context menu can also be used (see below).
    </li>

    <li><b>Help <img src="images/icons/Help22.png"></b><br>
        Displays this page.
    </li>

</ul>

<h4>Context Menu</h4>

<p>A click with the right mouse button on the diagram opens a context menu
    comprising the following menu items:</p>
<ul>
    <li><b>Properties...</b><br>
        Edit several properties (colors, axes, etc.) of the diagram.<br>
        The <img src="images/icons/Edit24.gif"> on the right 'Plot' panel can also be used.
    </li>
    <li><b>Copy</b><br>
        Copies the diagram as image into the clipboard.<br>
    </li>
    <li><b>Save As...</b><br>
        Save the diagram as image (PNG). <br>
        The <img src="images/icons/Export24.gif"> on the right 'Plot' panel can also be used.
    </li>
    <li><b>Print...</b><br>
        Print the diagram.<br>
        The <img src="images/icons/Print24.gif"> on the right 'Plot' panel can also be used.
    </li>
    <li><b>Zoom In</b><br>
        <ul>
            <li>Both Axes - Zoom in on both axes.<br></li>
            Zooming can also be achieved by drawing a rectangle by clicking at the top left corner of the desired
            zooming area, dragging the mouse to the bottom right corner, and releasing. Note that this won't work when
            'Select Mask 'histogram_plot_area'' is selected.
            <li>Domain Axes - Zoom in only on the domain axis.</li>
            <li>Range Axes - Zoom in only on the range axis.</li>
        </ul>
    </li>
    <li><b>Zoom Out</b><br>
        <ul>
            <li>Both Axes - Zoom out on both axes.<br></li>
            <li>Domain Axes - Zoom out only on the domain axis.</li>
            <li>Range Axes - Zoom out only on the range axis.</li>
        </ul>
    </li>
    <li><b>Auto Range</b><br>
        <ul>
            <li>Both Axes - Adjusts both axes to the full data range.<br>
                The <img src="images/icons/View-Fullscreen22.png"> on the right 'Plot' panel can also be used.
            </li>
            <li>Domain Axes - Adjusts the domain axis to the full data range.</li>
            <li>Range Axes - Adjusts the range axis to the full data range.</li>
        </ul>
    </li>
    <li><b>Select Mask 'histogram_plot_area'</b><br>
        Allows the user to create a mask from the histogram.
        After selecting the menu entry, a horizontal range in the histogram can be chosen by clicking at one end of
        the range, dragging the mouse to the other end, and releasing.
        The mask will be selected immediately.
    </li>
    <li><b>Delete Mask 'histogram_plot_area'</b><br>
        Removes the mask 'histogram_plot_area' (in case it has been created before).
    </li>
    <li><b>Copy Data to Clipboard</b><br>
        This will copy the diagram data as tabulated text to the system clipboard.
        The copied text can then be pasted directly into a spreadsheet application
        (e.g. Microsoft&reg; Excel).
    </li>
</ul>
<hr>
</body>
</html>

<!--page visited by UK-->
